home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / XmSeparatorGadget.z / XmSeparatorGadget
Text File  |  1998-10-30  |  18KB  |  265 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrrGGGGaaaaddddggggeeeetttt((((3333XXXX))))     UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV     XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrrGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrrGGGGaaaaddddggggeeeetttt - The SeparatorGadget widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           #include <Xm/SeparatoG.h>
  13.  
  14.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  15.           This page documents Motif 2.1.
  16.  
  17.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.           SeparatorGadget separates items in a display.  Several line
  19.           drawing styles are provided, as well as horizontal or
  20.           vertical orientation.
  21.  
  22.           Lines drawn within the SeparatorGadget are automatically
  23.           centered within the height of the gadget for a horizontal
  24.           orientation and centered within the width of the gadget for
  25.           a vertical orientation.  An XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss with a new
  26.           XXXXmmmmNNNNsssseeeeppppaaaarrrraaaattttoooorrrrTTTTyyyyppppeeee resizes the widget to its minimal height
  27.           (for horizontal orientation) or its minimal width (for
  28.           vertical orientation) unless height or width is explicitly
  29.           set in the XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss call.
  30.  
  31.           SeparatorGadget does not draw shadows around the separator.
  32.           The Gadget resource XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss is used for the
  33.           SeparatorGadget's thickness when XXXXmmmmNNNNsssseeeeppppaaaarrrraaaattttoooorrrrTTTTyyyyppppeeee is
  34.           XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____IIIINNNN, XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____IIIINNNN____DDDDAAAASSSSHHHH,
  35.           XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____OOOOUUUUTTTT, or XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____OOOOUUUUTTTT____DDDDAAAASSSSHHHH.
  36.  
  37.           SeparatorGadget does not highlight and allows no traversing.
  38.           The Gadget resource XXXXmmmmNNNNttttrrrraaaavvvveeeerrrrssssaaaallllOOOOnnnn is forced to False.
  39.           SeparatorGadget holds the _X_m_Q_T_m_e_n_u_S_a_v_v_y trait.
  40.  
  41.         CCCCllllaaaasssssssseeeessss
  42.           SeparatorGadget inherits behavior, resources, and traits
  43.           from OOOObbbbjjjjeeeecccctttt, RRRReeeeccccttttOOOObbbbjjjj, and XXXXmmmmGGGGaaaaddddggggeeeetttt.
  44.  
  45.           The class pointer is _x_m_S_e_p_a_r_a_t_o_r_G_a_d_g_e_t_C_l_a_s_s.
  46.  
  47.           The class name is XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrrGGGGaaaaddddggggeeeetttt.
  48.  
  49.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  50.           The following table defines a set of widget resources used
  51.           by the programmer to specify data. The programmer can also
  52.           set the resource values for the inherited classes to set
  53.           attributes for this widget. To reference a resource by name
  54.           or by class in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  55.           prefix and use the remaining letters. To specify one of the
  56.           defined values for a resource in a ....XXXXddddeeeeffffaaaauuuullllttttssss file, remove
  57.           the XXXXmmmm prefix and use the remaining letters (in either
  58.           lowercase or uppercase, but include any underscores between
  59.           words).  The codes in the access column indicate if the
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrrGGGGaaaaddddggggeeeetttt((((3333XXXX))))     UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV     XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrrGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           given resource can be set at creation time (C), set by using
  75.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  76.           not applicable (N/A).
  77.  
  78.                                    XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrrGGGGaaaaddddggggeeeetttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  79.           NNNNaaaammmmeeee               CCCCllllaaaassssssss              TTTTyyyyppppeeee            DDDDeeeeffffaaaauuuulllltttt              AAAAcccccccceeeessssssss
  80.           XmNmargin          XmCMargin          Dimension       0                    CSG
  81.           XmNorientation     XmCOrientation     unsigned char   XmHORIZONTAL         CSG
  82.           XmNseparatorType   XmCSeparatorType   unsigned char   XmSHADOW_ETCHED_IN   CSG
  83.  
  84.           XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnn For horizontal orientation, specifies the space on
  85.                     the left and right sides between the border of
  86.                     SeparatorGadget and the line drawn.  For vertical
  87.                     orientation, specifies the space on the top and
  88.                     bottom between the border of SeparatorGadget and
  89.                     the line drawn.
  90.  
  91.           XXXXmmmmNNNNoooorrrriiiieeeennnnttttaaaattttiiiioooonnnn
  92.                     Specifies whether SeparatorGadget is displayed
  93.                     vertically or horizontally.  This resource can
  94.                     have values of XXXXmmmmVVVVEEEERRRRTTTTIIIICCCCAAAALLLL and XXXXmmmmHHHHOOOORRRRIIIIZZZZOOOONNNNTTTTAAAALLLL.
  95.  
  96.           XXXXmmmmNNNNsssseeeeppppaaaarrrraaaattttoooorrrrTTTTyyyyppppeeee
  97.                     Specifies the type of line drawing to be done in
  98.                     the Separator widget.
  99.  
  100.                     XXXXmmmmSSSSIIIINNNNGGGGLLLLEEEE____LLLLIIIINNNNEEEE
  101.                               Single line.
  102.  
  103.                     XXXXmmmmDDDDOOOOUUUUBBBBLLLLEEEE____LLLLIIIINNNNEEEE
  104.                               Double line.
  105.  
  106.                     XXXXmmmmSSSSIIIINNNNGGGGLLLLEEEE____DDDDAAAASSSSHHHHEEEEDDDD____LLLLIIIINNNNEEEE
  107.                               Single-dashed line.
  108.  
  109.                     XXXXmmmmDDDDOOOOUUUUBBBBLLLLEEEE____DDDDAAAASSSSHHHHEEEEDDDD____LLLLIIIINNNNEEEE
  110.                               Double-dashed line.
  111.  
  112.                     XXXXmmmmNNNNOOOO____LLLLIIIINNNNEEEE No line.
  113.  
  114.                     XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____IIIINNNN
  115.                               A line whose shadows give the effect of
  116.                               a line etched into the window. The
  117.                               thickness of the line is equal to the
  118.                               value of XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss. For
  119.                               horizontal orientation, the top shadow
  120.                               is drawn in XXXXmmmmNNNNttttooooppppSSSShhhhaaaaddddoooowwwwCCCCoooolllloooorrrrand the
  121.                               bottom shadow is drawn in
  122.                               XXXXmmmmNNNNbbbboooottttttttoooommmmSSSShhhhaaaaddddoooowwwwCCCCoooolllloooorrrr. For vertical
  123.                               orientation, the left edge is drawn in
  124.                               XXXXmmmmNNNNttttooooppppSSSShhhhaaaaddddoooowwwwCCCCoooolllloooorrrrand the right edge is
  125.                               drawn in XXXXmmmmNNNNbbbboooottttttttoooommmmSSSShhhhaaaaddddoooowwwwCCCCoooolllloooorrrr.
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrrGGGGaaaaddddggggeeeetttt((((3333XXXX))))     UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV     XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrrGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  137.  
  138.  
  139.  
  140.                     XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____OOOOUUUUTTTT
  141.                               A line whose shadows give the effect of
  142.                               an etched line coming out of the window.
  143.                               The thickness of the line is equal to
  144.                               the value of XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss. For
  145.                               horizontal orientation, the top shadow
  146.                               is drawn in XXXXmmmmNNNNbbbboooottttttttoooommmmSSSShhhhaaaaddddoooowwwwCCCCoooolllloooorrrr and the
  147.                               bottom shadow is drawn in
  148.                               XXXXmmmmNNNNttttooooppppSSSShhhhaaaaddddoooowwwwCCCCoooolllloooorrrr. For vertical
  149.                               orientation, the left edge is drawn in
  150.                               XXXXmmmmNNNNbbbboooottttttttoooommmmSSSShhhhaaaaddddoooowwwwCCCCoooolllloooorrrr and the right edge
  151.                               is drawn in XXXXmmmmNNNNttttooooppppSSSShhhhaaaaddddoooowwwwCCCCoooolllloooorrrr.
  152.  
  153.                     XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____IIIINNNN____DDDDAAAASSSSHHHH
  154.                               Identical to XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____IIIINNNN except a
  155.                               series of lines creates a dashed line.
  156.  
  157.                     XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____OOOOUUUUTTTT____DDDDAAAASSSSHHHH
  158.                               Identical to XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____OOOOUUUUTTTT except
  159.                               a series of lines creates a dashed line.
  160.  
  161.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  162.           SeparatorGadget inherits behavior and resources from the
  163.           superclasses in the following tables.  For a complete
  164.           description of each resource, refer to the reference page
  165.           for that superclass.
  166.  
  167.                                                XXXXmmmmGGGGaaaaddddggggeeeetttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  168.           NNNNaaaammmmeeee                    CCCCllllaaaassssssss                   TTTTyyyyppppeeee               DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  169.           XmNbackground           XmCBackground           Pixel              dynamic                CSG
  170.           XmNbackgroundPixmap     XmCPixmap               Pixmap             XmUNSPECIFIED_PIXMAP   CSG
  171.           XmNbottomShadowColor    XmCBottomShadowColor    Pixel              dynamic                CSG
  172.           XmNbottomShadowPixmap   XmCBottomShadowPixmap   Pixmap             dynamic                CSG
  173.           XmNhelpCallback         XmCCallback             XtCallbackList     NULL                   C
  174.           XmNforeground           XmCForeground           Pixel              dynamic                CSG
  175.           XmNhighlightColor       XmCHighlightColor       Pixel              dynamic                CSG
  176.           XmNhighlightOnEnter     XmCHighlightOnEnter     Boolean            False                  CSG
  177.           XmNhighlightPixmap      XmCHighlightPixmap      Pixmap             dynamic                CSG
  178.           XmNhighlightThickness   XmCHighlightThickness   Dimension          0                      CSG
  179.           XmNlayoutDirection      XmNCLayoutDirection     XmDirection        dynamic                CG
  180.           XmNnavigationType       XmCNavigationType       XmNavigationType   XmNONE                 CSG
  181.           XmNshadowThickness      XmCShadowThickness      Dimension          2                      CSG
  182.           XmNtopShadowColor       XmCTopShadowColor       Pixel              dynamic                CSG
  183.           XmNtopShadowPixmap      XmCTopShadowPixmap      Pixmap             dynamic                CSG
  184.           XmNtraversalOn          XmCTraversalOn          Boolean            False                  G
  185.           XmNunitType             XmCUnitType             unsigned char      dynamic                CSG
  186.           XmNuserData             XmCUserData             XtPointer          NULL                   CSG
  187.  
  188.                                   RRRReeeeccccttttOOOObbbbjjjj RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  189.           NNNNaaaammmmeeee                   CCCCllllaaaassssssss            TTTTyyyyppppeeee        DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                         (printed 10/24/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrrGGGGaaaaddddggggeeeetttt((((3333XXXX))))     UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV     XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrrGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  203.  
  204.  
  205.  
  206.           XmNancestorSensitive   XmCSensitive     Boolean     dynamic   G
  207.           XmNborderWidth         XmCBorderWidth   Dimension   0         N/A
  208.           XmNheight              XmCHeight        Dimension   dynamic   CSG
  209.           XmNsensitive           XmCSensitive     Boolean     True      CSG
  210.           XmNwidth               XmCWidth         Dimension   dynamic   CSG
  211.           XmNx                   XmCPosition      Position    0         CSG
  212.           XmNy                   XmCPosition      Position    0         CSG
  213.  
  214.                                   OOOObbbbjjjjeeeecccctttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  215.           NNNNaaaammmmeeee                 CCCCllllaaaassssssss         TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  216.           XmNdestroyCallback   XmCCallback   XtCallbackList   NULL      C
  217.  
  218.         BBBBeeeehhhhaaaavvvviiiioooorrrr
  219.           XXXXmmmmSSSSeeeeppppaaaarrrraaaattttoooorrrrGGGGaaaaddddggggeeeetttt has no behavior.
  220.  
  221.      RRRREEEELLLLAAAATTTTEEEEDDDD
  222.           OOOObbbbjjjjeeeecccctttt(3), RRRReeeeccccttttOOOObbbbjjjj(3), XXXXmmmmCCCCrrrreeeeaaaatttteeeeSSSSeeeeppppaaaarrrraaaattttoooorrrrGGGGaaaaddddggggeeeetttt(3), and
  223.           XXXXmmmmGGGGaaaaddddggggeeeetttt(3).
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                         (printed 10/24/98)
  262.  
  263.  
  264.  
  265.